Outbound WIRE Debit

The 'Outbound WIRE Debit' API enables to process the WIRE debit transaction initiated by the sender to send funds to the beneficiary bank account

Method: POST

{{URL}}/rpc/paymentv2

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to initiate Wire transaction through ledger service Constant value – "ledger.wire"
id Mandatory	String Unique ID of API request Sample value – "1"
params Mandatory	Object
payload Mandatory	Object
channel Mandatory	String Payment channel through which the transaction is processed Constant value – "WIRE"
transactionType Mandatory	String Type of transaction Constant value – "WIRE_OUT"
product Mandatory	String Application from where the transaction in initiated Constant value – "LEDGER"
program Mandatory	String Program name/id of a customer typically includes the customer ID Sample value – "100000000000005"
reference Mandatory	String Unique reference ID of the transaction Sample value – "R90987899999"
transactionDateTime Optional	String Date and time of the transaction is initiated (format: "YYYY-MM-DD HH:MM:SS") Sample value – "2021-01-19 06:20:25"
reason Optional	String Purpose of the transaction Sample value – "Settlement"
transactionAmount Mandatory	Object
amount Mandatory	String Amount of the transaction Sample value – "200"
currency Mandatory	String Type of currency used for transaction Sample value – "USD"
debtorAccount Mandatory	Object
identification Mandatory	String Value of identification type Sample value – "200630040685832"
identificationType Mandatory	String Identification type of debtor account Sample value – "ACCOUNT_NUMBER"
identificationType2 Optional	Enum Additional identification type of debtor account Valid values: SAVINGS - To deposit for saving purpose CHECKING - For daily use WALLET - To store pre-paid money for daily usage MONEY_MARKET - Interest bearing account (based on interest rates) CREDIT_CARD - To track only the credit card transactions GL - General Ledger for accounting record CUSTODIAL - For the benefit of other financial institution Sample value – "SAVINGS"
institution Mandatory	Object
name Optional	String Financial Institution or Bank name where the debtor holds the account Sample value – "NetXD"
identification Mandatory	String Value of identification type Sample value – "011110646"
identificationType Mandatory	String Identification type of debtor's financial institution or bank Sample value – "ABA"
creditorAccount Mandatory	Object
identification Mandatory	String Value of identification type Sample value – "200686362505215"
identificationType Mandatory	String Identification type of creditor account Sample value – "ACCOUNT_NUMBER"
institution Mandatory	Object
name Optional	String Financial Institution or Bank name where the creditor holds the account Sample value – "NetXD"
identification Mandatory	String Value of identification type Sample value – "011000015"
identificationType Mandatory	String Identification type of creditor's financial institution or bank Sample value – "ABA"
creditor Mandatory	Object
firstName Mandatory	String First name of creditor Sample value – "Andy"
userType Mandatory	Enum Type of creditor Valid values: ACCOUNT_HOLDER ACCOUNT_HOLDER_BUSINESS LEGAL_REP NON_ACCOUNT_HOLDER NON_ACCOUNT_HOLDER_BUSINESS ORIGINATOR ORIGINATOR_BUSINESS SHAREHOLDER SIGNATORY SHAREHOLDER_BUSINESS TELLER TECHNOLOGY_SERVICE_PROVIDER MSB VIRTUAL_ACCOUNT_HOLDER NONE BENEFICIARY INDIVIDUAL BILLER BSA_OFFICER CONTROLPERSON KEYMANAGEMENT CONSUMER MERCHANT Sample value – "INDIVIDUAL"
identification Optional	String Value of identification type Sample value – "89900200014"
identificationType Optional	String Identification type of creditor Sample value – "SSN"
api Mandatory	Object
credential Mandatory	String API credential provided by NetXD Sample value – "Credential"
signature Mandatory	String Signature for request validation Sample value – "signature"
apiKey Mandatory	String API key used for user authentication Sample value – "apikey"

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"ledger.wire","id":"1","params":{"payload":{"channel":"WIRE","transactionType":"WIRE_OUT","product":"LEDGER","program":"100000000000005","reference":"R90987899999","transactionDateTime":"2021-01-19 06:20:25","reason":"Settlement","transactionAmount":{"amount":"200","currency":"USD"},"debtorAccount":{"identification":"200630040685832","identificationType":"ACCOUNT_NUMBER","identificationType2":"SAVINGS","institution":{"name":"NetXD","identification":"011110646","identificationType":"ABA"}},"creditorAccount":{"identification":"200686362505215","identificationType":"ACCOUNT_NUMBER","institution":{"name":"NetXD","identification":"011000015","identificationType":"ABA"}},"creditor":{"FirstName":"Andy","userType":"INDIVIDUAL","identification":"89900200014","identificationType":"SSN"}},"api":{"credential":"{{Credential}}","signature":"{{signature}}","apiKey":"{{ApiKey}}"}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""ledger.wire"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""channel"": ""WIRE"",
" + "\n" +
@"      ""transactionType"": ""WIRE_OUT"",
" + "\n" +
@"      ""product"": ""LEDGER"",
" + "\n" +
@"      ""program"": ""100000000000005"",
" + "\n" +
@"      ""reference"": ""R90987899999"",
" + "\n" +
@"      ""transactionDateTime"": ""2021-01-19 06:20:25"",
" + "\n" +
@"      ""reason"": ""Settlement"",
" + "\n" +
@"      ""transactionAmount"": {
" + "\n" +
@"        ""amount"": ""200"",
" + "\n" +
@"        ""currency"": ""USD""
" + "\n" +
@"      },
" + "\n" +
@"      ""debtorAccount"": {
" + "\n" +
@"        ""identification"": ""200630040685832"",
" + "\n" +
@"        ""identificationType"": ""ACCOUNT_NUMBER"",
" + "\n" +
@"        ""identificationType2"": ""SAVINGS"",
" + "\n" +
@"        ""institution"": {
" + "\n" +
@"          ""name"": ""NetXD"",
" + "\n" +
@"          ""identification"": ""011110646"",
" + "\n" +
@"          ""identificationType"": ""ABA""
" + "\n" +
@"        }
" + "\n" +
@"      },
" + "\n" +
@"      ""creditorAccount"": {
" + "\n" +
@"        ""identification"": ""200686362505215"",
" + "\n" +
@"        ""identificationType"": ""ACCOUNT_NUMBER"",
" + "\n" +
@"        ""institution"": {
" + "\n" +
@"          ""name"": ""NetXD"",
" + "\n" +
@"          ""identification"": ""011000015"",
" + "\n" +
@"          ""identificationType"": ""ABA""
" + "\n" +
@"        }
" + "\n" +
@"      },
" + "\n" +
@"      ""creditor"": {
" + "\n" +
@"        ""FirstName"": ""Andy"",
" + "\n" +
@"        ""userType"": ""INDIVIDUAL"",
" + "\n" +
@"        ""identification"": ""89900200014"",
" + "\n" +
@"        ""identificationType"": ""SSN""
" + "\n" +
@"      }
" + "\n" +
@"    },
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""credential"": ""{{Credential}}"",
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""apiKey"": ""{{ApiKey}}""
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "ledger.wire",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "payload": {`+"
"+`
      "channel": "WIRE",`+"
"+`
      "transactionType": "WIRE_OUT",`+"
"+`
      "product": "LEDGER",`+"
"+`
      "program": "100000000000005",`+"
"+`
      "reference": "R90987899999",`+"
"+`
      "transactionDateTime": "2021-01-19 06:20:25",`+"
"+`
      "reason": "Settlement",`+"
"+`
      "transactionAmount": {`+"
"+`
        "amount": "200",`+"
"+`
        "currency": "USD"`+"
"+`
      },`+"
"+`
      "debtorAccount": {`+"
"+`
        "identification": "200630040685832",`+"
"+`
        "identificationType": "ACCOUNT_NUMBER",`+"
"+`
        "identificationType2": "SAVINGS",`+"
"+`
        "institution": {`+"
"+`
          "name": "NetXD",`+"
"+`
          "identification": "011110646",`+"
"+`
          "identificationType": "ABA"`+"
"+`
        }`+"
"+`
      },`+"
"+`
      "creditorAccount": {`+"
"+`
        "identification": "200686362505215",`+"
"+`
        "identificationType": "ACCOUNT_NUMBER",`+"
"+`
        "institution": {`+"
"+`
          "name": "NetXD",`+"
"+`
          "identification": "011000015",`+"
"+`
          "identificationType": "ABA"`+"
"+`
        }`+"
"+`
      },`+"
"+`
      "creditor": {`+"
"+`
        "FirstName": "Andy",`+"
"+`
        "userType": "INDIVIDUAL",`+"
"+`
        "identification": "89900200014",`+"
"+`
        "identificationType": "SSN"`+"
"+`
      }`+"
"+`
    },`+"
"+`
    "api": {`+"
"+`
      "credential": "{{Credential}}",`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "apiKey": "{{ApiKey}}"`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ledger.wire",
  "id": "1",
  "params": {
    "payload": {
      "channel": "WIRE",
      "transactionType": "WIRE_OUT",
      "product": "LEDGER",
      "program": "100000000000005",
      "reference": "R90987899999",
      "transactionDateTime": "2021-01-19 06:20:25",
      "reason": "Settlement",
      "transactionAmount": {
        "amount": "200",
        "currency": "USD"
      },
      "debtorAccount": {
        "identification": "200630040685832",
        "identificationType": "ACCOUNT_NUMBER",
        "identificationType2": "SAVINGS",
        "institution": {
          "name": "NetXD",
          "identification": "011110646",
          "identificationType": "ABA"
        }
      },
      "creditorAccount": {
        "identification": "200686362505215",
        "identificationType": "ACCOUNT_NUMBER",
        "institution": {
          "name": "NetXD",
          "identification": "011000015",
          "identificationType": "ABA"
        }
      },
      "creditor": {
        "FirstName": "Andy",
        "userType": "INDIVIDUAL",
        "identification": "89900200014",
        "identificationType": "SSN"
      }
    },
    "api": {
      "credential": "{{Credential}}",
      "signature": "{{signature}}",
      "apiKey": "{{ApiKey}}"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "ledger.wire",
  "id": "1",
  "params": {
    "payload": {
      "channel": "WIRE",
      "transactionType": "WIRE_OUT",
      "product": "LEDGER",
      "program": "100000000000005",
      "reference": "R90987899999",
      "transactionDateTime": "2021-01-19 06:20:25",
      "reason": "Settlement",
      "transactionAmount": {
        "amount": "200",
        "currency": "USD"
      },
      "debtorAccount": {
        "identification": "200630040685832",
        "identificationType": "ACCOUNT_NUMBER",
        "identificationType2": "SAVINGS",
        "institution": {
          "name": "NetXD",
          "identification": "011110646",
          "identificationType": "ABA"
        }
      },
      "creditorAccount": {
        "identification": "200686362505215",
        "identificationType": "ACCOUNT_NUMBER",
        "institution": {
          "name": "NetXD",
          "identification": "011000015",
          "identificationType": "ABA"
        }
      },
      "creditor": {
        "FirstName": "Andy",
        "userType": "INDIVIDUAL",
        "identification": "89900200014",
        "identificationType": "SSN"
      }
    },
    "api": {
      "credential": "{{Credential}}",
      "signature": "{{signature}}",
      "apiKey": "{{ApiKey}}"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value – "1"
result	Object
api	Object
type	String Type of transaction Constant value – "WIRE_OUT_ACK"
reference	String Unique reference Id of the transaction Sample value – "R90987899999"
dateTime	String Date and time of the transaction is initiated (format: "YYYY-MM-DD HH:MM:SS") Sample value – "2023-09-15 10:23:42"
account	Object
accountId	String Unique account Id of debtor Sample value – "200630040685832"
balanceCents	Number Remaining account balance of debtor in cents Sample value – 1400
holdBalanceCents	Number Hold balance of debtor in cents Sample value – 600
status	Enum Status of the debtor account Valid values: CREATED - Account has been newly created ACTIVE - Account is currently active and can be used for transactions CURTAILED - Account functionalities are limited DORMANT - Account is inactive for a specific period SUSPENDED - Account is Temporarily disabled BLOCKED - Account is restricted from performing any transactions CLOSED - Account is permanently terminated and can no longer be used DISABLED - Account is inactive and unusable, either temporarily or permanently Sample value – "ACTIVE"
transactionNumber	String Unique transaction number that is assigned for the transaction Sample value – "QA00000001104003"
transactionStatus	Enum Status of the transaction Valid values: COMPLETED PENDING FAILED DECLINED REJECTED Sample value – "COMPLETED"
transactionAmountCents	Number Transaction amount in cents Sample value – 200
originalRequestBase64	String Base64 encoded data for received xml message Sample value – "Base64 encoded data for received xml message"
processId	String Unique process ID assigned to track end to end process of transaction Sample value – "PL23091501043003"
header	Object
reference	String Unique reference ID of the transaction Sample value – "R90987899999"
apiKey	String API key used for user authentication Sample value – "ba28a31cc1244bc7a5f400b17abd4c03"
signature	String Signature for request validation Sample value – "signature"

{
  "id": "1",
  "result": {
    "api": {
      "type": "WIRE_OUT_ACK",
      "reference": "R90987899999",
      "dateTime": "2023-09-15 10:23:42"
    },
    "account": {
      "accountId": "200630040685832",
      "balanceCents": 1400,
      "holdBalanceCents": 600,
      "status": "ACTIVE"
    },
    "transactionNumber": "QA00000001104003",
    "transactionStatus": "COMPLETED",
    "transactionAmountCents": 200,
    "originalRequestBase64": "eyJjaGFubmVsIjoiV0lSRSIsInRyYW5zYWN0aW9uVHlwZSI6IldJUkVfT1VUIiwicHJvZHVjdCI6IkpQT1MiLCJwcm9ncmFtIjoiSlBPUyIsInRyYW5zYWN0aW9uRGF0ZVRpbWUiOiIyMDIxLTAxLTE5IDA2OjIwOjI1IiwicmVmZXJlbmNlIjoiUjkwOTg3ODk5OTk5IiwicmVhc29uIjoiU2V0dGxlbWVudCIsInRyYW5zYWN0aW9uQW1vdW50Ijp7ImFtb3VudCI6IjIwMCIsImN1cnJlbmN5IjoiVVNEIn0sImRlYnRvckFjY291bnQiOnsiaWRlbnRpZmljYXRpb24iOiIyMDA2Mjc4ODA3OTQzNzYiLCJpZGVudGlmaWNhdGlvblR5cGUiOiJBQ0NPVU5UX05VTUJFUiIsImlkZW50aWZpY2F0aW9uVHlwZTIiOiJTQVZJTkdTIiwiaW5zdGl0dXRpb24iOnsibmFtZSI6IkNCVyBCQU5LIiwiaWRlbnRpZmljYXRpb24iOiIwMTExMTA2NDYiLCJpZGVudGlmaWNhdGlvblR5cGUiOiJBQkEifX0sImNyZWRpdG9yIjp7InVzZXJUeXBlIjoiSU5ESVZJRFVBTCIsImlkZW50aWZpY2F0aW9uIjoiMjAwOTE3NjIyIiwiaWRlbnRpZmljYXRpb25UeXBlIjoiQUNDT1VOVF9OVU1CRVIiLCJmaXJzdE5hbWUiOiJ0ZXN0In0sImNyZWRpdG9yQWNjb3VudCI6eyJpZGVudGlmaWNhdGlvbiI6IjIwMDY4NjM2MjUwNTIxNSIsImlkZW50aWZpY2F0aW9uVHlwZSI6IkFDQ09VTlRfTlVNQkVSIiwiaW5zdGl0dXRpb24iOnsibmFtZSI6IkNCVyBCQU5LIiwiaWRlbnRpZmljYXRpb24iOiIwMTEwMDAwMTUiLCJpZGVudGlmaWNhdGlvblR5cGUiOiJBQkEifX19",
    "processId": "PL23091501043003"
  },
  "header": {
    "reference": "R90987899999",
    "apiKey": "ba28a31cc1244bc7a5f400b17abd4c03",
    "signature": "MEQCIAUtkxi1Wpz1dTYSP047lq8SWoyrYd0TBH4mVqkDmbUyAiApb2IsJVuJdyH0iR8Z6C66bX3UEAGchott5iQlE1Xt3A=="
  }
}